home *** CD-ROM | disk | FTP | other *** search
/ Amiga Magazin: Amiga-CD 1996 March / Amiga-CD 1996 #3.iso / pd-software / mui_3.1 / developer / autodocs / mui_menuitem.doc < prev    next >
Text File  |  1996-01-19  |  3KB  |  123 lines
  1. TABLE OF CONTENTS
  2.  
  3. Menuitem.mui/Menuitem.mui
  4. Menuitem.mui/MUIA_Menuitem_Checked
  5. Menuitem.mui/MUIA_Menuitem_Checkit
  6. Menuitem.mui/MUIA_Menuitem_Enabled
  7. Menuitem.mui/MUIA_Menuitem_Exclude
  8. Menuitem.mui/MUIA_Menuitem_Shortcut
  9. Menuitem.mui/MUIA_Menuitem_Title
  10. Menuitem.mui/MUIA_Menuitem_Toggle
  11. Menuitem.mui/MUIA_Menuitem_Trigger
  12. Menuitem.mui/Menuitem.mui
  13.  
  14.     Menuitem class describes a single menu item. You can use
  15.     all of the gadtools menus features expect Image menus here.
  16.  
  17.     Since Menuitem class is a subclass of Family class, you can
  18.     add other menu items as children of a menu item to indicate
  19.     sub menus. MUI does not limit the level of sub menus, but
  20.     the operating system currently allows a maximum nesting
  21.     level of one. Because of this, children of menu items
  22.     should not contain other menu items for now, the results
  23.     are unpredictable.
  24.  
  25.     Note: For handling menu items, MUIA_UserData and the methods
  26.     MUIM_SetUData, MUIM_GetUData and MUIM_FindUData can become
  27.     quite useful. See the Menu demo program and the accompanying
  28.         documentation for details.
  29. Menuitem.mui/MUIA_Menuitem_Checked
  30.  
  31.     NAME
  32.     MUIA_Menuitem_Checked -- (V8 ) [ISG], BOOL
  33.  
  34.     FUNCTION
  35.     set/get the checked state of a checkit menu item.
  36.  
  37.     SEE ALSO
  38.     MUIA_Menuitem_Checkit, MUIA_Menuitem_Enabled, 
  39.     MUIA_Menuitem_Exclude
  40. Menuitem.mui/MUIA_Menuitem_Checkit
  41.  
  42.     NAME
  43.     MUIA_Menuitem_Checkit -- (V8 ) [ISG], BOOL
  44.  
  45.     FUNCTION
  46.     Set to TRUE and this item will become a checkmarkable item.
  47.  
  48.     SEE ALSO
  49.     MUIA_Menuitem_Checked, MUIA_Menuitem_Enabled,
  50.     MUIA_Menuitem_Exclude
  51. Menuitem.mui/MUIA_Menuitem_Enabled
  52.  
  53.     NAME
  54.     MUIA_Menuitem_Enabled -- (V8 ) [ISG], BOOL
  55.  
  56.     FUNCTION
  57.     enabled/disalbe the menu item.
  58.  
  59.     SEE ALSO
  60.     MUIA_Menuitem_Checkit, MUIA_Menuitem_Checked,
  61.     MUIA_Menuitem_Exclude
  62. Menuitem.mui/MUIA_Menuitem_Exclude
  63.  
  64.     NAME
  65.     MUIA_Menuitem_Exclude -- (V8 ) [ISG], LONG
  66.  
  67.     FUNCTION
  68.     bitmask of menu item numbers that are to be deselected
  69.     when this one is selected.
  70.  
  71.     SEE ALSO
  72.     MUIA_Menuitem_Checkit, MUIA_Menuitem_Enabled,
  73.     MUIA_Menuitem_Checked
  74. Menuitem.mui/MUIA_Menuitem_Shortcut
  75.  
  76.     NAME
  77.     MUIA_Menuitem_Shortcut -- (V8 ) [ISG], STRPTR
  78.  
  79.     SPECIAL INPUTS
  80.     MUIV_Menuitem_Shortcut_Check
  81.  
  82.     FUNCTION
  83.     Define the shortcut for a menu item.
  84.  
  85.     SEE ALSO
  86.     MUIA_Menuitem_Title
  87. Menuitem.mui/MUIA_Menuitem_Title
  88.  
  89.     NAME
  90.     MUIA_Menuitem_Title -- (V8 ) [ISG], STRPTR
  91.  
  92.     FUNCTION
  93.     Define the items title.
  94.  
  95.     SEE ALSO
  96.     MUIA_Menuitem_Shortcut
  97. Menuitem.mui/MUIA_Menuitem_Toggle
  98.  
  99.     NAME
  100.     MUIA_Menuitem_Toggle -- (V8 ) [ISG], BOOL
  101.  
  102.     FUNCTION
  103.     Define the state of the TOGGLE flag for this item.
  104.  
  105.     SEE ALSO
  106.     MUIA_Menuitem_Checkit, MUIA_Menuitem_Enabled,
  107.     MUIA_Menuitem_Checked
  108. Menuitem.mui/MUIA_Menuitem_Trigger
  109.  
  110.     NAME
  111.     MUIA_Menuitem_Trigger -- (V8 ) [..G], struct MenuItem *
  112.  
  113.     FUNCTION
  114.     This attribute is set to a pointer to the struct MenuItem of
  115.     the item object when the item is selected. By setting up
  116.     notification on this attribute with MUIV_EveryTime, you can
  117.     react on menu actions and query the MenuItems flags
  118.     immediately.
  119.  
  120.     Note that menu reactions are also possible any 
  121.     maybe a bit easier with MUIA_Application_ReturnID,
  122.     MUIA_Application_MenuAction and MUIA_Window_MenuAction.
  123.